New telepresence replace command. #3764

thallgren · 2025-01-08T11:29:26Z

The new telepresence replace command simplifies and clarifies container replacement.

Previously, the --replace flag within the telepresence intercept command was used to replace containers. However, this approach introduced inconsistencies and limitations:

Confusion: Using a flag to modify the core function of a command designed for traffic interception led to ambiguity.
Inaccurate Behavior: Replacement was not possible when no incoming traffic was intercepted, as the command's design focused on traffic routing.

To address these issues, the --replace flag within telepresence intercept has been deprecated. The new telepresence replace command provides a dedicated and consistent method for replacing containers, enhancing clarity and reliability.

Key differences between replace and intercept:

Scope: The replace command targets and affects an entire container, impacting all its traffic, while an intercept targets specific services and/or service/container ports.
Port Declarations: Remote ports specified using the --port flag are container ports.
No Default Port: A replace can occur without intercepting any ports.
Container State: During a replace, the original container is no longer active within the cluster.

The deprecated --replace flag still works, but is hidden from the telepresence intercept command help, and will print a deprecation warning when used.

thallgren · 2025-01-08T11:30:43Z

Still a draft. Integration and docs are in the works.

Signed-off-by: Thomas Hallgren <[email protected]>

Introducing `telepresence replace` as an alternative to the `intercept` resulted in a lot of documentation changes. For many (most) use-cases, a `replace` is more natural than an `intercept` unless there's an ability to do personal intercepts, and the OSS edition doesn't provide that. Signed-off-by: Thomas Hallgren <[email protected]>

Signed-off-by: Thomas Hallgren <[email protected]>

Most of the panic recovery routines were added to ensure logging the stack-trace of the panic. Containers in pods seem to run with `GOTRACEBACK=""` which apparently overrides the default "single" setting. To mitigate this, the traffic-manager, traffic-agent, and agent-init containers now use the `debug.SetTraceback("single")` Signed-off-by: Thomas Hallgren <[email protected]>

Signed-off-by: Thomas Hallgren <[email protected]>

P0lip · 2025-02-10T17:57:56Z

docs/reference/intercepts/cli.md

I'm not sure how the hosted documentation URLs are built, but if they are inferred from the directory structure, we could rename the intercepts directory here

P0lip · 2025-02-10T18:41:44Z

cmd/traffic/cmd/manager/mutator/service.go

we still have panic recovery in we still have serveMutatingFunc - didn't you intend to remove it in 59fb3f7#diff-e6df1931e03199997ae8c5c0ec6325293de7862dd39912c2995d2099cfa06032?

P0lip · 2025-02-10T18:45:34Z

pkg/client/cli/cmd/genyaml.go

+	}
+	flags := cmd.Flags()
+	flags.StringVarP(&info.workloadName, "workload", "w", "",
+		"Name of the workload. If given, the configmap entry will be retrieved telepresence-agents configmap, mutually exclusive to --config")


Suggested change

"Name of the workload. If given, the configmap entry will be retrieved telepresence-agents configmap, mutually exclusive to --config")

"Name of the workload. If given, the configmap entry will be retrieved from the telepresence-agents configmap, mutually exclusive to --config")

P0lip

Nice, I like the removal of tp agents configmap

P0lip · 2025-02-10T18:58:20Z

integration_test/workloads_test.go

@@ -24,6 +24,7 @@ func (s *connectedSuite) successfulIntercept(tp, wl, port string) {
 		2*time.Second, // polling interval
 	)

+	itest.TelepresenceOk(ctx, "loglevel", "trace")


It'd be good to restore to the previous state

Suggested change

itest.TelepresenceOk(ctx, "loglevel", "trace")

itest.TelepresenceOk(ctx, "loglevel", "trace")

defer itest.TelepresenceOk(ctx, "loglevel", "debug")

Signed-off-by: Thomas Hallgren <[email protected]>

- Remove panic recovery in mutator/service.go - Remove extraneous loglevel setting in succesfulIntercept itest - Remove unused `--workload` flag from some genyaml commands. Signed-off-by: Thomas Hallgren <[email protected]>

thallgren marked this pull request as draft January 8, 2025 11:29

thallgren requested a review from P0lip January 8, 2025 11:31

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 8, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 8, 2025

thallgren force-pushed the thallgren/replace-command branch from 1d01171 to 002afbe Compare January 8, 2025 22:50

thallgren requested a review from njayp January 8, 2025 22:51

thallgren force-pushed the thallgren/replace-command branch from 002afbe to b31a69e Compare January 8, 2025 22:54

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 9, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 9, 2025

thallgren force-pushed the thallgren/replace-command branch from b31a69e to e816443 Compare January 9, 2025 18:34

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 9, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 9, 2025

thallgren force-pushed the thallgren/replace-command branch from e816443 to 681a5a0 Compare January 9, 2025 23:39

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 9, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 9, 2025

thallgren force-pushed the thallgren/replace-command branch from 681a5a0 to b4c333f Compare January 10, 2025 06:41

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

thallgren force-pushed the thallgren/replace-command branch 4 times, most recently from 074f21b to d0d27c8 Compare January 10, 2025 08:24

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

thallgren force-pushed the thallgren/replace-command branch from d0d27c8 to 215d7ff Compare January 10, 2025 10:10

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

thallgren force-pushed the thallgren/replace-command branch from 215d7ff to 198d06a Compare January 10, 2025 10:48

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Jan 10, 2025

thallgren added 6 commits February 8, 2025 15:51

Slightly more efficient echo-server.

11e056b

Signed-off-by: Thomas Hallgren <[email protected]>

Really massage concurrency in Test_LargeRequest.

76d10e0

Signed-off-by: Thomas Hallgren <[email protected]>

Ensure removal of PV and PVC in integration tests.

f34dde3

Signed-off-by: Thomas Hallgren <[email protected]>

Close root daemon connection to traffic-manager early on disconnect.

4393162

Signed-off-by: Thomas Hallgren <[email protected]>

Let conn<->stream dispatcher close reader and writer of conn separately

096f34a

Signed-off-by: Thomas Hallgren <[email protected]>

thallgren force-pushed the thallgren/replace-command branch from 1ab6cf4 to 311de3e Compare February 8, 2025 14:58

thallgren marked this pull request as ready for review February 8, 2025 14:59

Let make docs-files target generate docs/variables.yaml from changelog.

1c93498

Signed-off-by: Thomas Hallgren <[email protected]>

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 8, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 8, 2025

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 8, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 8, 2025

thallgren added 2 commits February 8, 2025 23:36

Ensure that agent watchers don't receive inactivated agents.

f57e3c1

Signed-off-by: Thomas Hallgren <[email protected]>

thallgren force-pushed the thallgren/replace-command branch from ee12df7 to 59fb3f7 Compare February 8, 2025 22:45

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 8, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 8, 2025

Fixup and enable Test_LargeFiles for CI.

c5dad04

Signed-off-by: Thomas Hallgren <[email protected]>

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 9, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 9, 2025

P0lip reviewed Feb 10, 2025

View reviewed changes

P0lip approved these changes Feb 10, 2025

View reviewed changes

thallgren added 2 commits February 10, 2025 23:55

Rename docs/references/intercepts to engagements.

75db6a4

Signed-off-by: Thomas Hallgren <[email protected]>

Changes in response to code review.

b1fe5a6

- Remove panic recovery in mutator/service.go - Remove extraneous loglevel setting in succesfulIntercept itest - Remove unused `--workload` flag from some genyaml commands. Signed-off-by: Thomas Hallgren <[email protected]>

thallgren force-pushed the thallgren/replace-command branch from 028c18b to b1fe5a6 Compare February 10, 2025 22:55

thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 10, 2025

github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Feb 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New telepresence replace command. #3764

New telepresence replace command. #3764

thallgren commented Jan 8, 2025

thallgren commented Jan 8, 2025

P0lip Feb 10, 2025

P0lip Feb 10, 2025

P0lip Feb 10, 2025

P0lip left a comment

P0lip Feb 10, 2025

	"Name of the workload. If given, the configmap entry will be retrieved telepresence-agents configmap, mutually exclusive to --config")
	"Name of the workload. If given, the configmap entry will be retrieved from the telepresence-agents configmap, mutually exclusive to --config")

	itest.TelepresenceOk(ctx, "loglevel", "trace")
	itest.TelepresenceOk(ctx, "loglevel", "trace")
	defer itest.TelepresenceOk(ctx, "loglevel", "debug")

New telepresence replace command. #3764

Are you sure you want to change the base?

New telepresence replace command. #3764

Conversation

thallgren commented Jan 8, 2025

thallgren commented Jan 8, 2025

P0lip Feb 10, 2025

Choose a reason for hiding this comment

P0lip Feb 10, 2025

Choose a reason for hiding this comment

P0lip Feb 10, 2025

Choose a reason for hiding this comment

P0lip left a comment

Choose a reason for hiding this comment

P0lip Feb 10, 2025

Choose a reason for hiding this comment